Merge docs inline

svn path=/trunk/; revision=21960

diff --git a/ChangeLog b/ChangeLog
index 0f154a12ae537c12559a61aa527c4da8a1844f84..5899e25784205a8e3bbf6c3ebeb765b45ad7d33d 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,6 @@
 2008-12-28  Matthias Clasen  <mclasen@redhat.com>
 
+       * gtk/gtkscrolledwindow.c: 
        * gtk/gtkscale.c: Merge docs inline.
 
 2008-12-28  Ryan Lortie  <desrt@desrt.ca>

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 797dee09441567887174b60824901872b98968e3..e844d256a3ded1da8d334580f1a62597496e13ba 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,5 +1,6 @@
 2008-12-28  Matthias Clasen <mclasen@redhat.com>
 
+       * gtk/tmpl/gtkscrolledwindow.sgml:
        * gtk/tmpl/gtkscale.sgml: Merge docs inline.
 
 2008-12-28  Matthias Clasen <mclasen@redhat.com>

diff --git a/docs/reference/gtk/tmpl/gtkscrolledwindow.sgml b/docs/reference/gtk/tmpl/gtkscrolledwindow.sgml
index aac0384978a6bed8ec1419c8ef685098e132d692..2bae2743e2c178227ba22d741c3b12052d83edfc 100644 (file)
--- a/docs/reference/gtk/tmpl/gtkscrolledwindow.sgml
+++ b/docs/reference/gtk/tmpl/gtkscrolledwindow.sgml
@@ -82,7 +82,7 @@ only be accessed using the functions below.
 
 </para>
 
-@scrolledwindow: the object which received the signal.
+@scrolledwindow: 
 @arg1: 
 
 <!-- ##### SIGNAL GtkScrolledWindow::scroll-child ##### -->
@@ -90,7 +90,7 @@ only be accessed using the functions below.
 
 </para>
 
-@scrolledwindow: the object which received the signal.
+@scrolledwindow: 
 @arg1: 
 @arg2: 
 @Returns: 
@@ -142,38 +142,30 @@ only be accessed using the functions below.
 
 <!-- ##### FUNCTION gtk_scrolled_window_new ##### -->
 <para>
-Creates a new scrolled window. The two arguments are the scrolled
-window's adjustments; these will be shared with the scrollbars and the
-child widget to keep the bars in sync with the child. Usually you want
-to pass %NULL for the adjustments, which will cause the scrolled window
-to create them for you.
+
 </para>
 
-@hadjustment: Horizontal adjustment.
-@vadjustment: Vertical adjustment.
-@Returns: New scrolled window.
+@hadjustment: 
+@vadjustment: 
+@Returns: 
 
 
 <!-- ##### FUNCTION gtk_scrolled_window_get_hadjustment ##### -->
 <para>
-Returns the horizontal scrollbar's adjustment, used to connect the
-horizontal scrollbar to the child widget's horizontal scroll
-functionality.
+
 </para>
 
-@scrolled_window: A #GtkScrolledWindow.
-@Returns: The horizontal #GtkAdjustment.
+@scrolled_window: 
+@Returns: 
 
 
 <!-- ##### FUNCTION gtk_scrolled_window_get_vadjustment ##### -->
 <para>
-Returns the vertical scrollbar's adjustment, used to connect the
-vertical scrollbar to the child widget's vertical scroll
-functionality.
+
 </para>
 
-@scrolled_window: A #GtkScrolledWindow.
-@Returns: The vertical #GtkAdjustment.
+@scrolled_window: 
+@Returns: 
 
 
 <!-- ##### FUNCTION gtk_scrolled_window_get_hscrollbar ##### -->
@@ -196,59 +188,30 @@ functionality.
 
 <!-- ##### FUNCTION gtk_scrolled_window_set_policy ##### -->
 <para>
-Sets the scrollbar policy for the horizontal and vertical scrollbars. 
-The policy determines when the scrollbar should appear; it is a value
-from the #GtkPolicyType enumeration. If %GTK_POLICY_ALWAYS, the
-scrollbar is always present; if %GTK_POLICY_NEVER, the scrollbar is
-never present; if %GTK_POLICY_AUTOMATIC, the scrollbar is present only
-if needed (that is, if the slider part of the bar would be smaller
-than the trough - the display is larger than the page size).
+
 </para>
 
-@scrolled_window: A #GtkScrolledWindow.
-@hscrollbar_policy: Policy for horizontal bar.
-@vscrollbar_policy: Policy for vertical bar.
+@scrolled_window: 
+@hscrollbar_policy: 
+@vscrollbar_policy: 
 
 
 <!-- ##### FUNCTION gtk_scrolled_window_add_with_viewport ##### -->
 <para>
-Used to add children without native scrolling capabilities. This is
-simply a convenience function; it is equivalent to adding the
-unscrollable child to a viewport, then adding the viewport to the
-scrolled window. If a child has native scrolling, use
-gtk_container_add() instead of this function.
-</para>
-
-<para>
-The viewport scrolls the child by moving its #GdkWindow, and takes the
-size of the child to be the size of its toplevel #GdkWindow. This will
-be very wrong for most widgets that support native scrolling; for
-example, if you add a widget such as #GtkTreeView with a viewport, the 
-whole widget will scroll, including the column headings. Thus, widgets
-with native scrolling support should not be used with the #GtkViewport proxy.
-</para>
 
-<para>
-A widget supports scrolling natively if the
-set_scroll_adjustments_signal field in #GtkWidgetClass is non-zero,
-i.e. has been filled in with a valid signal identifier.
 </para>
 
-@scrolled_window: A #GtkScrolledWindow.
-@child: Widget you want to scroll.
+@scrolled_window: 
+@child: 
 
 
 <!-- ##### FUNCTION gtk_scrolled_window_set_placement ##### -->
 <para>
-Determines the location of the child widget with respect to the
-scrollbars. The default is %GTK_CORNER_TOP_LEFT, meaning the child is
-in the top left, with the scrollbars underneath and to the right.
-Other values in #GtkCornerType are %GTK_CORNER_TOP_RIGHT,
-%GTK_CORNER_BOTTOM_LEFT, and %GTK_CORNER_BOTTOM_RIGHT.
+
 </para>
 
-@scrolled_window: A #GtkScrolledWindow.
-@window_placement: Position of the child window.
+@scrolled_window:
+@window_placement:
 
 
 <!-- ##### FUNCTION gtk_scrolled_window_unset_placement ##### -->
@@ -270,20 +233,20 @@ Other values in #GtkCornerType are %GTK_CORNER_TOP_RIGHT,
 
 <!-- ##### FUNCTION gtk_scrolled_window_set_hadjustment ##### -->
 <para>
-Sets the #GtkAdjustment for the horizontal scrollbar.
+
 </para>
 
-@scrolled_window: A #GtkScrolledWindow.
-@hadjustment: Horizontal scroll adjustment.
+@scrolled_window:
+@hadjustment:
 
 
 <!-- ##### FUNCTION gtk_scrolled_window_set_vadjustment ##### -->
 <para>
-Sets the #GtkAdjustment for the vertical scrollbar.
+
 </para>
 
-@scrolled_window: A #GtkScrolledWindow.
-@vadjustment: Vertical scroll adjustment.
+@scrolled_window:
+@vadjustment: 
 
 
 <!-- ##### FUNCTION gtk_scrolled_window_get_placement ##### -->

diff --git a/gtk/gtkscrolledwindow.c b/gtk/gtkscrolledwindow.c
index 3f8d7175822350db30e5a241410c19a8261b22a9..ff274a983e217f8b72366a16a51b260ce42566f3 100644 (file)
--- a/gtk/gtkscrolledwindow.c
+++ b/gtk/gtkscrolledwindow.c
@@ -588,12 +588,14 @@ gtk_scrolled_window_set_policy (GtkScrolledWindow *scrolled_window,
 /**
  * gtk_scrolled_window_get_policy:
  * @scrolled_window: a #GtkScrolledWindow
- * @hscrollbar_policy: location to store the policy for the horizontal scrollbar, or %NULL.
- * @vscrollbar_policy: location to store the policy for the horizontal scrollbar, or %NULL.
+ * @hscrollbar_policy: location to store the policy for the horizontal 
+ *     scrollbar, or %NULL.
+ * @vscrollbar_policy: location to store the policy for the vertical
+ *     scrollbar, or %NULL.
  * 
  * Retrieves the current policy values for the horizontal and vertical
  * scrollbars. See gtk_scrolled_window_set_policy().
- **/
+ */
 void
 gtk_scrolled_window_get_policy (GtkScrolledWindow *scrolled_window,
                                GtkPolicyType     *hscrollbar_policy,
@@ -665,6 +667,7 @@ gtk_scrolled_window_set_placement_set (GtkScrolledWindow *scrolled_window,
  *
  * Sets the placement of the contents with respect to the scrollbars
  * for the scrolled window.
+ * 
  * The default is %GTK_CORNER_TOP_LEFT, meaning the child is
  * in the top left, with the scrollbars underneath and to the right.
  * Other values in #GtkCornerType are %GTK_CORNER_TOP_RIGHT,
@@ -672,7 +675,7 @@ gtk_scrolled_window_set_placement_set (GtkScrolledWindow *scrolled_window,
  *
  * See also gtk_scrolled_window_get_placement() and
  * gtk_scrolled_window_unset_placement().
- **/
+ */
 void
 gtk_scrolled_window_set_placement (GtkScrolledWindow *scrolled_window,
                                   GtkCornerType      window_placement)